Avoid unnecessary work

Fix vertical off-by-one error

When the usage information is displayed at the top or bottom (as
controlled by `which-key-show-prefix'), then we already accounted
for that by putting (- max-height 1) bindings in each row.  But
we did not ensure that the max-height is used when displaying the
result.  Instead we used (- max-height 1) here too.

When trying to display usage information at the bottom, the result is
that it is not displayed because it is off-window.  When displaying at
the top, then it is displayed, but the last binding is off-window and
never displayed.

This bug did not matter (much) when using the default settings because
then the code used for displaying the window actually ignores the
max-height and just uses the height appropriate to display all lines
in the buffer (i.e., (+ max-height 1)).  However, other display
methods, including but not necessarily limited to third-party methods
(such as `which-key-posframe') may choose to, or absolutely have to,
respect max-height.  In particular, anything that tries to use the
full height of a frame or window, will be affected by this.

Fix horizontal off-by-one error

Delay increasing width used by columns until we know that we have to
do so because we have determined that there is enough room to add an
additional column and a space between the last two columns.

If we don't do that, then we can easily get an off-by-one error.  If
docstrings are shown and the window is narrow, then it is likely that
we end up using the maximal width.  If we then add one to the actual
width and later compare that again with the maximal width, then that
is too width.

Don't pad beyond maximal width

The old implementation behaved as if the "description" is the only
information that is being displayed, however in actuality the
available width has to be shared with the key (and the separator
between the two).

Failing to take that into account meant that every binding whose
description isn't *by itself* wider than the width available to
display all the information got excessive padding, which later has to
be removed during truncation again (resulting in misleading ellipses).

Displaying just one column means pages are arranged vertically

Third-party display methods may do that without using a side-window,
and therefore they don't set `which-key-popup-type' to `side-window'.
Likewise they might not set `which-key-side-window-location', e.g.,
because their display method only supports one location.

`which-key-max-display-columns' being 1 is by itself already enough
of an indicator to know that there won't be multiple columns.

Calculate format string only once

Add group to minor-mode definition

Fixes #339

Merge remote-tracking branch 'origin/master'

Add an example to README for keymap binding

See #338

Bump version

Don't allow transient maps when prefix length is zero.

Fixes #335

Fix typo in ellipsis

Merge pull request #329 from hans-d/feat-elipsis

add which-key-elipsis

Merge branch 'feat-columnsize'

Fix code column width

Merge pull request #331 from skangas/gnu-elpa-badge

Add GNU ELPA badge

Add GNU ELPA badge to README.org

add which-key-elipsis

add which-key-min-column-description-width

Update to the newer advice API

Patch submitted by Stefan Monnier

Fix key-chord handling

It turns out we don't need to do anything too tricky for key-chords, because
this-single-command-raw-keys returns the correct key-sequence

Fixes #254

Respect which-key-min-display-lines setting

Fixes #325

Allow binding to symbols in which-key-C-h-dispatch

Fixes #326

Merge pull request #327 from anis-semmar/patch-1

README.org: fix page flipping command names

Merge pull request #321 from fredericgiquel/preserve-window-configuration

Preserve window configuration

README.org: fix page flipping command names

`which-key-show-next-page` / `which-key-show-previous-page` do not exist, state the correct command name.

Merge pull request #323 from Zetagon/master

Add missing argument to function call

Add missing argument to function call

Add option (default off) to restore window configuration

Merge pull request #313 from duncanburke/master

Add support for help-char being a generalized input event

Preserve window configuration

Merge pull request #315 from peniblec/keymap-names

Fix some keymap names not showing up

Fix some keymap names not showing up

Closes #314.

Add support for help-char being a generalized input event

Not all keyboard events can be represented as a character. For example,
while ?\C-h is a character, represented as 8 in decimal, C-M-h is
represented by 134217736 in decimal, as can be obtained from:

(elt (kbd "C-M-h") 0)

It is useful to allow help-char to be set to something other than a
character, as characters cover only a very small region of possible
input events. This is especially important because help-char is used to
bring up the pagination menu (when which-key-use-C-h-commands is t), and
this won't work if it conflicts with any keybinding within the prefix
command that led to the activation of which-key.

If help-char is left set to ?\C-h things work fine because as a
convention keymaps avoid binding that due to it being the default
binding for help. That is just a convention, however, and things become
more difficult with a heavily user-customized set of keybindings that
preclude the use of ?\C-h for that purpose.

In that case, if ?\C-h cannot be used, it is much easier to find a
binding for help-char that is unlikely to conflict with any bindings if
it is permitted to use the full range of modifier keys.

This patch modifies which-key--next-page-hint, which is the only place
that broke when I set help-char to a keyboard event that wasn't a
character. Rather than doing a string comparison, help-char and prefix
keys are put in vectors and equality is checked that way.

Remove more instances of obsolete variables.

Merge remote-tracking branch 'origin/master'

Remove some obsolete variables/functions

Don't require evil in which-key-tests.el

Patch from Stefan Monnier

Fix compiler warnings

Fixes #312

Handle closure definition type

Fixes #311

Improve which-key-add-keymap-based-replacements.

Also, teach which-key--safe-lookup-key to handle numeric results.

Clarify usage of keymap replacements in docstrings and README

Clean up some docstrings

Clean up which-key--maybe-replace

Improve which-key-add-keymap-based-bindings

Add a test

Fix key sort order functions

We now always get the full key description (prefix + binding)

Try again to fix tests

Turn off fail-fast in github action

Try without cask

Add install python step to github action

Fix which-key--group-p

length> is a new function maybe

Try with cask again

Fix github action

Fix test

Update README

Make enable-extended-define-key obsolete

Merge branch 'alt-get-bindings'

Fix detection of named prefix bindings

Fix menu-item bidning retrieval

Fix prefix sorting

Fix add-keymap-based-bindings and associated test

Expand get-keymap-bindings test

Fix type usage and arglists for new functions

Fix default of which-key-replacement-alist

Update tests

Remove pseudo binding stuff

It's not necessary anymore with manual parsing of the keymaps

Alternative approach to retrieving bindings (WIP)

Merge pull request #305 from tarsiiformes/first-line

Improve first doc-string line in trivial cases

Improve first doc-string line in trivial cases

The first line of a doc-string should form a complete sentence.
Many doc-strings in this package do not follow that convention
but fixing them all would be difficult and is beyond the scope
of this commit.  However, in a few cases the fix is trivial and
this commit tackles those instances.

Fix whitespace

Fix whitespace

Fix recent commit

Fix README links

Reference issues #93 and #175 in README

Fixes #291

Merge pull request #303 from tarsiiformes/posframe

Support packages that use another frame to display bindings

Get which-key--buffer's window from any frame

Previously we assumed the buffer was being displayed in a window
of the current frame, which isn't the case if e.g. a child frame
is being used.

We also cannot assume that the third-party code that sets up such
a child frame also deletes it.  `which-key-posframe' for example
merely hides it.

Cosmetics

Avoid code-duplication in which-key--hide-popup

Fix nesting-level of "God-mode" section

fix which-key--show-keymap for which-key-enable-extended-define-key

With which-key-enable-extended-define-key set to 't, given the keymap
and bindings below:

  (setq a-map (make-sparse-keymap))
  (bind-keys :map a-map
             ("a" . ("key 1" . command-1))
             ("b" . ("key b" . command-2)))

The output of (which-key--get-keymap-bindings a-map) was having
"unknown" as the key descriptions.

This change fixes it therefore allows the following to work as
expected:

(which-key--show-keymap "A map" a-map)

Unset header-line-format format in " *which-key*" buffer

Similarly to mode-line-format, header-line-format just takes up space and
currently also breaks window size calculations for the buffer. This sets
it to nil in order to suppress its display.

Signed-off-by: Frank Terbeck <ft@bewatermyfriend.org>

Update reference to obsolete variable in DOCSTRING (#285)

Version 3.5.1

Further simplify which-key--pseudo-key

simplify pseudo key

REAMDE code's Number of parentheses pairs (#270)

Add tests for keymap-based-bindings

Clarify README's description of keymap-based replacement

Version 3.5.0

Fix which-key--next-page-hint

prefix-keys might be a vector.

Fixes #265

Hide paging hint when prefix is help-char

We can't do paging in this case.

Improve keymap-based-replacement description in README

Ref #263

Remove use of focus-{in,out}-hook

Fix #259 #260 #262

Remove testing badge from README

Github integrates the results into the interface already, and it doesn't seem to
work.

Stop testing against v24.5

It's old enough now

Add which-key-add-keymap-based-replacements

This is an alternative to advising define-key using
which-key-enable-extended-define-key, but functions the same beneath the
surface.

Ref #226 #261

Fix #257 (#258)

* Add test for #257

Signed-off-by: Rudi Grinberg <me@rgrinberg.com>
* Fix #257

Explicitly distinguish between replacing with `nil` and not replacing at
all.

I'm also simplifying the code by making all the branches more explicit.
This is a little longer, but makes all the clauses obvious.

Signed-off-by: Rudi Grinberg <me@rgrinberg.com>

Speed up which-key--maybe-replace

The first optimization is avoiding the intermediate list created by
append. Instead we just iterate over the two lists in turn

The second opimitization occurs where
which-key-allow-multiple-replacements is nil, in which case we can stop
the iteration once we've found a replacement

Signed-off-by: Rudi Grinberg <me@rgrinberg.com>

Add basic PR template

Fix which-key--propertize-description use make-text-button return value (#249)

As of:

https://github.com/emacs-mirror/emacs/commit/7ac79872aed63110c0d26c1e62e1838d6101c9bd

make-text-button no longer modifies a string when it is passed as the
first argument. which-key--propertize-description relied on the mutation
of the string argument. Using the return value of make-text-button will
return the propertized string with both the new and old behavior.

Fixes #248